/*
 * Licensed to the Tai Ping Jin Ke
 *
 * Copyright (c) 2022 .
 * All rights reserved.
 * 项目名称：太平金科-通用能力封装层-公共组件
 * 版权说明：本软件属太平金融科技服务(上海)有限公司所有，在未获得太平金融科技服务(上海)有限公司正式授权情况下，任何企业和个人，不能获取、阅读、安装、传播本软件涉及的任何受知识产权保护的内容。
 */
package com.taipingframework.utility.web;

import java.io.Serializable;
import java.time.LocalDateTime;

public interface IApiResult<T extends Object & Serializable> {

    /**
     * 将HTTP请求标识反馈给前端。请求ID。
     */
    String getRequestId();

    /**
     * 返回码。
     */
    String getCode();

    /**
     * 返回码描述。
     */
    String getMessage();

    /**
     * 请求是否成功。
     */
    Boolean getSuccess();

    /**
     * 网络服务 获取返回的数据对象
     */
    T getResult() throws CloneNotSupportedException;

    /**
     * 需要排查异常情况时，能够帮助程序员迅速定位到发生错误的时间节点，禁止修改
     */
    LocalDateTime getTimestamp();

}
